home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / shell-tools / reboot 2 / reboot.doc < prev    next >
Encoding:
Text File  |  1996-03-18  |  6.8 KB  |  193 lines
  1.  
  2. /*
  3. **
  4. **  $VER: Reboot.doc 1.3 (18.3.96)
  5. **  Reboot 1.3
  6. **
  7. **  documentation
  8. **
  9. **  (C) Copyright 1994-96 by Roland 'Gizzy' Mainz
  10. **          All Rights Reserved
  11. **
  12. */
  13.  
  14. =====================   Reboot 1.3 documentation   ========================
  15. ===========================================================================
  16. A   simple   tool   to  be  used   with  Kickstart 2.x/3.x,  written  by
  17.  Roland 'Gizzy' Mainz,  freeware, all rights reserved.
  18. No guarantee of any kind is made that  the programm described below in this
  19.  document is 100% reliable. You use this material on your own risk.
  20.  
  21.  
  22. =========================== Misc ==========================================
  23. ===========================================================================
  24. While playing with ENVOY 1.6, I need a program which allows to reboot
  25. another AMIGA through the network (by my own "RemoteNetShell") or
  26. after a given time.
  27. First I wrote a little script (using WAIT) and a C program calling
  28. exec.library/ColdReboot() to solve this problem.
  29. Switching to IAM's ENVOY 2.0 I replaced this script by this tool,
  30. adding some features (WB (including multiselect), SHELL ReadArgs(),
  31. locale support and test mode).
  32.  
  33. In the first release (V1.1) were four bugs:
  34. 1. The "Abort reboot" requester couldn't be canceld 1 second before
  35.    the given time.
  36.    Fixed.
  37. 2. I did not read the autodocs exactly:
  38.    The function BuildEasyRequest might return 0 or 1 at low mem time.
  39.    Now Reboot simply fails with ERROR_NO_FREE_STORE for both 0 or 1.
  40.    If 1 was returned, an enforcer hit would occur.
  41.    Never happed, but
  42.    fixed.
  43. 3. AttemptOpenLibrary could return (sometimes) random pointers.
  44.    In fact, this never happened by me, but maybe ...
  45.    Fixed.
  46. 4. While getting Reboot's environment variable, the "Abort reboot"
  47.    requester might be canceled. Now we check this:
  48.    Fixed.
  49.  
  50. Additional, there was some code cleanup which adds support for
  51. DICE INLINE calls.
  52.  
  53. The executable is now PURE and can be made resident.
  54.  
  55. The time between the program checks the "Abort reboot" requester has beed
  56. decrased down to a half second.
  57.  
  58. Starting with V1.3 environment variables are supported.
  59. Things set in var REBOOT (local or global) will be parsed after built-in
  60. default settings and before any user-given arguments (shell args or 
  61. project icons), which can overide those settings given there.
  62.  
  63. =========================== Installation ==================================
  64. ===========================================================================
  65. After unpacking this archieve:
  66.  
  67. Workbench:
  68.   - Drop the 'Reboot' icon in your favorite drawer (like
  69.      "SYS:Utilities/").
  70.     See SHELL for copying the catalog files.
  71.  
  72. Shell:
  73.   - Unpack this archieve at "SYS:Utilities/"
  74.     and add the following statements at your "S:user-startup" startup file:
  75.  
  76.     Assign Reboot: SYS:Utilities/Reboot
  77.     path Reboot: ADD
  78.   OR
  79.   - Drop/Copy the 'Reboot' file in your favorite directory
  80.     (like "Sys:Utilities").
  81.     To copy the (german) catalog files, type
  82.     Copy Catalogs/#? TO="LOCALE:Catalogs/" ALL QUIET CLONE
  83.  
  84. =============================== Usage =====================================
  85. ===========================================================================
  86.  
  87.     NAME
  88.         Reboot -- rebooting utility
  89.  
  90.     FORMAT
  91.         Reboot [REBOOTDELAY <seconds>] [QUIET|NOREQ] [OFF]
  92.  
  93.     TEMPLATE
  94.         REBOOTDELAY/K/N,QUIET=NOREQ/S,OFF/S
  95.  
  96.     TOOLTYPES
  97.         REBOOTDELAY/N
  98.         QUIET/S
  99.         NOREQ/S
  100.         OFF/S
  101.  
  102.     PURPOSE
  103.         To reboot the computer.
  104.  
  105.     SPECIFICATION
  106.         Reboot is used to reboot the whole computer like a "cold"
  107.         system start.
  108.  
  109.         Unless you specify otherwise (through REBOOTDELAY option), reboot
  110.         will wait 2 seconds before rebooting the system.
  111.         This is used to let the system (and it's disk drives) settle.
  112.         This delay time can't be less than 1 second, a REBOOTDELAY=0
  113.         will also wait this minimum time.
  114.  
  115.         Whenever the QUIET (or NOREQ) option is set, the verify requesters
  116.         ("Are you sure#?" etc.) will be suppressed.
  117.  
  118.         If the OFF switch is set, the tool act like when a CTRL-C signal
  119.         has been send to the tool.
  120.  
  121.         Variable support:
  122.         The environment REBOOT variable (either LOCAL or GLOBAL) can be
  123.         used for default settings. The parsing template for this
  124.         variable is the same like the shell template (see above).
  125.  
  126.         Reboot supports workbench multiselect (e.g. project icons) !
  127.  
  128.     BUGS/NOTES
  129.         Shell variables longer than 255 are currently not supported.
  130.  
  131.         "Set Reboot OFF" (e.g. using a local variable) is only valid if you
  132.         start Reboot from this shell.
  133.  
  134.         Running CPU FASTROM causes sometimes problems: The system reboots,
  135.         but then hang atfer a while ???
  136.  
  137.  
  138. =============================== TODO ======================================
  139. ===========================================================================
  140.   - AmigaGuide document "Reboot.guide"
  141.  
  142.  
  143. ============================== SOURCE =====================================
  144. ===========================================================================
  145. Reboot source and catalogs may be recompiled/reprocessed
  146. (using DICE-C, SAS-C or GNU-C) by executing Reboot.c.
  147.  
  148. If you would use SAS-C, you must enable the related shell statements (and
  149. the DICE ones must be disabled).
  150. Currenty the SAS-C section isn't tested.
  151.  
  152. GNU-C support will be done in one future version.
  153.  
  154. If you like to include a new language (like Français or Nederlands etc.),
  155. send me a filled "Reboot_blank.ct" file named "Reboot_#?.ct" (#? for your
  156. language). As an example, see "Reboot_deutsch.ct".
  157. Note that I can currently only process "Reboot_#?.ct" files whose language
  158. is supported by AmigaOS 3.1 (e.g. a CBM language driver exists).
  159.  
  160.  
  161. =========================== Author's Request ==============================
  162. ===========================================================================
  163. By  releasing  this program I do  not  place any obligations on you,
  164. feel free to share this program with your  friends (and enemies).
  165.  
  166. If you want to blame me, report any bugs, or wants a new version
  167. send your letter to:
  168.                 Roland Mainz
  169.                 Hohenstaufenstraße 8
  170.                 52388 Nörvenich
  171.                 GERMANY
  172.  
  173. EMAIL is also available:
  174. If you don't find a file "email.changed" in this archieve,
  175. my email address is:
  176.                 mainz@mats.gmd.de
  177.  
  178. Sorry, but I can only look once a month for mails.
  179.  
  180. The  entire  "Reboot"  package  may  be  noncommercially  redistributed,
  181. provided  that  the package  is always  distributed in it's complete  form
  182. (including it's documentation).  A small copy fee  for media costs is okay
  183. but any kind of commercial distribution is strictly forbidden!
  184. Comments  and  suggestions  how  to  improve  this  program  are generally
  185. appreciated!
  186.  
  187. Thanks to Matt Dillon for his DICE, and Olaf 'Olsen' Barthel for his
  188. help, ideas and some text clips from his documentations.
  189.  
  190.  
  191.  
  192.  
  193.